﻿/****************************************************************************************
*	Mouzetrap - client/server framework	
*
*	$HeadURL: http://mouzetrap.googlecode.com/svn/trunk/Mouzetrap/Network/Constants.cs $
*	$Id: Constants.cs 11 2009-06-11 09:10:25Z tobz@fallenrealms.net $
* 
*	Copyright (c) 2008 Toby Lawrence
* 
*	Permission is hereby granted, free of charge, to any person obtaining a copy
*	of this software and associated documentation files (the "Software"), to deal
*	in the Software without restriction, including without limitation the rights
*	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
*	copies of the Software, and to permit persons to whom the Software is
*	furnished to do so, subject to the following conditions:
* 
*	The above copyright notice and this permission notice shall be included in
*	all copies or substantial portions of the Software.
* 
*	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
*	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
*	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
*	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
*	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
*	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
*	THE SOFTWARE.
* 
****************************************************************************************/

namespace Mouzetrap.Network
{
	/// <summary>
	/// Holds network-specific constant values.
	/// </summary>
	public static class NetworkConstants
	{
		/// <summary>
		/// The default amount of packet buffers to pre-allocate.
		/// </summary>
		public const int DEFAULT_PBUF_COUNT = 1024;

		/// <summary>
		/// The default size of a packet buffer.
		/// </summary>
		public const int DEFAULT_PBUF_SIZE = 2048;

		/// <summary>
		/// The starting capacity for the backing stream of an <see cref="OutboundPacket{TIdentifier}" />.
		/// </summary>
		public const int OUTBOUND_CAPACITY = 128;
	}

	/// <summary>
	/// Defines the direction of a packet
	/// </summary>
	public enum PacketDirection
	{
		/// <summary>
		/// The packet has come to the server from a client.
		/// </summary>
		Inbound = 0,

		/// <summary>
		/// The packet is going to a client from the server.
		/// </summary>
		Outbound = 1
	}
}